home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sggev.z / sggev
Encoding:
Text File  |  2002-10-03  |  7.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGGEV - compute for a pair of N-by-N real nonsymmetric matrices (A,B)
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      SUBROUTINE SGGEV( JOBVL, JOBVR, N, A, LDA, B, LDB, ALPHAR, ALPHAI, BETA,
  13.                        VL, LDVL, VR, LDVR, WORK, LWORK, INFO )
  14.  
  15.          CHARACTER     JOBVL, JOBVR
  16.  
  17.          INTEGER       INFO, LDA, LDB, LDVL, LDVR, LWORK, N
  18.  
  19.          REAL          A( LDA, * ), ALPHAI( * ), ALPHAR( * ), B( LDB, * ),
  20.                        BETA( * ), VL( LDVL, * ), VR( LDVR, * ), WORK( * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SGGEV computes for a pair of N-by-N real nonsymmetric matrices (A,B) the
  37.      generalized eigenvalues, and optionally, the left and/or right
  38.      generalized eigenvectors.
  39.  
  40.      A generalized eigenvalue for a pair of matrices (A,B) is a scalar lambda
  41.      or a ratio alpha/beta = lambda, such that A - lambda*B is singular. It is
  42.      usually represented as the pair (alpha,beta), as there is a reasonable
  43.      interpretation for beta=0, and even for both being zero.
  44.  
  45.      The right eigenvector v(j) corresponding to the eigenvalue lambda(j) of
  46.      (A,B) satisfies
  47.  
  48.                       A * v(j) = lambda(j) * B * v(j).
  49.  
  50.      The left eigenvector u(j) corresponding to the eigenvalue lambda(j) of
  51.      (A,B) satisfies
  52.  
  53.                       u(j)**H * A  = lambda(j) * u(j)**H * B .
  54.  
  55.      where u(j)**H is the conjugate-transpose of u(j).
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  75.      JOBVL   (input) CHARACTER*1
  76.              = 'N':  do not compute the left generalized eigenvectors;
  77.              = 'V':  compute the left generalized eigenvectors.
  78.  
  79.      JOBVR   (input) CHARACTER*1
  80.              = 'N':  do not compute the right generalized eigenvectors;
  81.              = 'V':  compute the right generalized eigenvectors.
  82.  
  83.      N       (input) INTEGER
  84.              The order of the matrices A, B, VL, and VR.  N >= 0.
  85.  
  86.      A       (input/output) REAL array, dimension (LDA, N)
  87.              On entry, the matrix A in the pair (A,B).  On exit, A has been
  88.              overwritten.
  89.  
  90.      LDA     (input) INTEGER
  91.              The leading dimension of A.  LDA >= max(1,N).
  92.  
  93.      B       (input/output) REAL array, dimension (LDB, N)
  94.              On entry, the matrix B in the pair (A,B).  On exit, B has been
  95.              overwritten.
  96.  
  97.      LDB     (input) INTEGER
  98.              The leading dimension of B.  LDB >= max(1,N).
  99.  
  100.      ALPHAR  (output) REAL array, dimension (N)
  101.              ALPHAI  (output) REAL array, dimension (N) BETA    (output) REAL
  102.              array, dimension (N) On exit, (ALPHAR(j) + ALPHAI(j)*i)/BETA(j),
  103.              j=1,...,N, will be the generalized eigenvalues.  If ALPHAI(j) is
  104.              zero, then the j-th eigenvalue is real; if positive, then the j-
  105.              th and (j+1)-st eigenvalues are a complex conjugate pair, with
  106.              ALPHAI(j+1) negative.
  107.  
  108.              Note: the quotients ALPHAR(j)/BETA(j) and ALPHAI(j)/BETA(j) may
  109.              easily over- or underflow, and BETA(j) may even be zero.  Thus,
  110.              the user should avoid naively computing the ratio alpha/beta.
  111.              However, ALPHAR and ALPHAI will be always less than and usually
  112.              comparable with norm(A) in magnitude, and BETA always less than
  113.              and usually comparable with norm(B).
  114.  
  115.      VL      (output) REAL array, dimension (LDVL,N)
  116.              If JOBVL = 'V', the left eigenvectors u(j) are stored one after
  117.              another in the columns of VL, in the same order as their
  118.              eigenvalues. If the j-th eigenvalue is real, then u(j) = VL(:,j),
  119.              the j-th column of VL. If the j-th and (j+1)-th eigenvalues form
  120.              a complex conjugate pair, then u(j) = VL(:,j)+i*VL(:,j+1) and
  121.              u(j+1) = VL(:,j)-i*VL(:,j+1).  Each eigenvector will be scaled so
  122.              the largest component have abs(real part)+abs(imag. part)=1.  Not
  123.              referenced if JOBVL = 'N'.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            SSSSGGGGGGGGEEEEVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDVL    (input) INTEGER
  141.              The leading dimension of the matrix VL. LDVL >= 1, and if JOBVL =
  142.              'V', LDVL >= N.
  143.  
  144.      VR      (output) REAL array, dimension (LDVR,N)
  145.              If JOBVR = 'V', the right eigenvectors v(j) are stored one after
  146.              another in the columns of VR, in the same order as their
  147.              eigenvalues. If the j-th eigenvalue is real, then v(j) = VR(:,j),
  148.              the j-th column of VR. If the j-th and (j+1)-th eigenvalues form
  149.              a complex conjugate pair, then v(j) = VR(:,j)+i*VR(:,j+1) and
  150.              v(j+1) = VR(:,j)-i*VR(:,j+1).  Each eigenvector will be scaled so
  151.              the largest component have abs(real part)+abs(imag. part)=1.  Not
  152.              referenced if JOBVR = 'N'.
  153.  
  154.      LDVR    (input) INTEGER
  155.              The leading dimension of the matrix VR. LDVR >= 1, and if JOBVR =
  156.              'V', LDVR >= N.
  157.  
  158.      WORK    (workspace/output) REAL array, dimension (LWORK)
  159.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  160.  
  161.      LWORK   (input) INTEGER
  162.              The dimension of the array WORK.  LWORK >= max(1,8*N).  For good
  163.              performance, LWORK must generally be larger.
  164.  
  165.              If LWORK = -1, then a workspace query is assumed; the routine
  166.              only calculates the optimal size of the WORK array, returns this
  167.              value as the first entry of the WORK array, and no error message
  168.              related to LWORK is issued by XERBLA.
  169.  
  170.      INFO    (output) INTEGER
  171.              = 0:  successful exit
  172.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  173.              = 1,...,N:  The QZ iteration failed.  No eigenvectors have been
  174.              calculated, but ALPHAR(j), ALPHAI(j), and BETA(j) should be
  175.              correct for j=INFO+1,...,N.  > N:  =N+1: other than QZ iteration
  176.              failed in SHGEQZ.
  177.              =N+2: error return from STGEVC.
  178.  
  179. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  180.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  181.  
  182.      This man page is available only online.
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.